IEEE 2030.5 Editor Notes / Instructions
=======================================

* Note: I used a Mac for much of this.
* Note: I used Enterprise Architect v16 (32-bit as 64-bit had issues for me)
* To generate the XSD, you'll need an Enterprise Architect plug-in:
	- http://www.cimea.org

Checklist
---------
- Generate Model Chapter from EA
- Generate XSD from EA and post-process
- Generate Model HTML from EA
- Validate XML examples against XSD
- Generate EXI examples
- Generate WADL Chapter from spreadsheet
- Generate WADL from spreadsheet
- Name directory for zip file appropriately
- Incorporate into standard Word document:
	- XML Examples
	- EXI Examples
	- Model Chapter
	- WADL Chapter
	- Update references (Select All, F9)

Generating Examples
-------------------
- For diagrams, used UMLet (www.umlet.com)
- Validated XML with xmllint:
	xmllint --schema ./sep.xsd INPUTFILE(s) --noout

Generating Model HTML from EA
-----------------------------
(in Enterprise Architect):
1. Select "IEEE 2030.5" under Model->SmartGrid
2. From the "Publish" tab, select "HTML"->"Standard HTML Report"
3. Click "Generate"

Generating Model Chapter
------------------------
(in Enterprise Architect):
1. Select "IEEE 2030.5" under Model->SmartGrid
2. From the "Publish" tab, select Report Builder->Generate Documentation
3. Choose output format: DOCX
4. Use "SEP 2.0 Model Report" template
5. Click "Generate"

Generating XSD
--------------
(in Enterprise Architect):
1. Right-click on "IEEE 2030.5" -> Specialize -> CIM EA -> Generate Artifacts
2. Select "SEP2.0 XSD"
3. Set options:
	Namespace: urn:ieee:std:2030.5:ns
4. Use Source/ieee2030.5-xsd-post-process.py to further process the resulting XSD.

Generating WADL Chapter
-----------------------
1. Open WADL spreadsheet
2. Click "Create Word" button

Generating WADL XML
-------------------
1. Open WADL spreadsheet
2. Copy the contents (only to the left of the grey column) of the 'WADL Output' sheet into sep_wadl.xml
3. Format file:
	xmllint --format --output OUTPUTFILE INPUTFILE
4. Remove first line of file: (<?xml ...)

Updating WADL
-------------
1. Open WADL spreadsheet
2. Add rows to 'Controls' sheet (IDs are arbitrary so just increment, but sorting matters)
3. Add rows to 'WADL Output' sheet
4. Add rows to 'Doc Output' sheet
5. Edit name "wadl_doc" (Insert -> Name) to include new rows
